Class DHCPPoolImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.DHCPPoolImpl
All Implemented Interfaces:
IPCObject, DHCPPool

public class DHCPPoolImpl extends IPCObjectImpl implements DHCPPool
Information provided by the PKI file:

    \class DhcpPool
    
    \brief DhcpPool holds and manipulates the DHCP pool on the DHCP server.
    
    \example network().getDevice("Router0").getProcess("DhcpServer").getPoolAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getDhcpPoolName

      public String getDhcpPoolName()
      Information provided by the PKI file:
      
          \brief Returns the name of this pool.
          
          \return string, the name of this pool.
          
              
      Specified by:
      getDhcpPoolName in interface DHCPPool
      Returns:
      String Returns a String
    • getNetworkAddress

      public IPAddress getNetworkAddress()
      Information provided by the PKI file:
      
          \brief Returns the network address of this pool.
          
          \return ip, the network address of this pool.
          
              
      Specified by:
      getNetworkAddress in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • setNetworkMask

      public void setNetworkMask(IPAddress network, IPAddress mask)
      Information provided by the PKI file:
      
          \brief Sets the network address for this pool.
          
          \param network, the network address for this pool.
          \param mask, the subnet mask for this pool.
          
              
      Specified by:
      setNetworkMask in interface DHCPPool
      Parameters:
      network - Takes in a parameter of network
      mask - Takes in a parameter of mask
    • getSubnetMask

      public IPAddress getSubnetMask()
      Information provided by the PKI file:
      
          \brief Returns the subnet mask of this pool
          
          \return ip, the subnet mask of this pool.
          
              
      Specified by:
      getSubnetMask in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • setDefaultRouter

      public void setDefaultRouter(IPAddress ipAddress)
      Information provided by the PKI file:
      
          \brief Sets the default router address.
          
          \param ipAddress, the IP address of the default router.
          
              
      Specified by:
      setDefaultRouter in interface DHCPPool
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
    • getDefaultRouter

      public IPAddress getDefaultRouter()
      Information provided by the PKI file:
      
          \brief Returns the default router IP address.
          
          \return ip, the default router IP address.
          
              
      Specified by:
      getDefaultRouter in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • getLeaseAt

      public DHCPPoolLease getLeaseAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the DHCP lease at the specified index.
          
          \param index, the index of the DHCP lease of interest.
          
          \return DhcpPoolLease, the DhcpPoolLease object at the specified index.
          
              
      Specified by:
      getLeaseAt in interface DHCPPool
      Parameters:
      index - Takes in a parameter of index
      Returns:
      DHCPPoolLease Returns a DHCPPoolLease
    • setStartIp

      public void setStartIp(IPAddress ipAddress)
      Information provided by the PKI file:
      
          \brief Sets the start IP address for this pool.
          
          \param ipAddress, the start IP address for this pool.
          
              
      Specified by:
      setStartIp in interface DHCPPool
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
    • setNextAvailableIpAddress

      public void setNextAvailableIpAddress(IPAddress ipAddress)
      Specified by:
      setNextAvailableIpAddress in interface DHCPPool
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
    • setEndIp

      public void setEndIp(IPAddress ipAddress)
      Information provided by the PKI file:
      
          \brief Sets the end IP address for this pool.
          
          \param ipAddress, the end IP address for this pool.
          
              
      Specified by:
      setEndIp in interface DHCPPool
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
    • setNetworkAddress

      public void setNetworkAddress(IPAddress ipAddress)
      Specified by:
      setNetworkAddress in interface DHCPPool
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
    • getStartIp

      public IPAddress getStartIp()
      Information provided by the PKI file:
      
          \brief Returns the start IP address of this pool.
          
          \return ip, the start IP address of this pool.
          
              
      Specified by:
      getStartIp in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • getEndIp

      public IPAddress getEndIp()
      Information provided by the PKI file:
      
          \brief Returns the end IP address of this pool.
          
          \return ip, the end IP address of this pool.
          
              
      Specified by:
      getEndIp in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • setDnsServerIp

      public void setDnsServerIp(IPAddress ipAddress)
      Information provided by the PKI file:
      
          \brief Sets the DNS server IP address.
          
          \param ipAddress, the DNS server IP address.
          
              
      Specified by:
      setDnsServerIp in interface DHCPPool
      Parameters:
      ipAddress - Takes in a parameter of ipAddress
    • getDnsServerIp

      public IPAddress getDnsServerIp()
      Information provided by the PKI file:
      
          \brief Returns the DNS server IP address.
          
          \return ip, the DNS server IP address.
          
              
      Specified by:
      getDnsServerIp in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • getDomainName

      public String getDomainName()
      Information provided by the PKI file:
      
          \brief Returns the domain name.
          
          \return string, the domain name.
          
              
      Specified by:
      getDomainName in interface DHCPPool
      Returns:
      String Returns a String
    • getMaxUsers

      public int getMaxUsers()
      Information provided by the PKI file:
      
          \brief Returns the maximum number of users.
          
          \return int, the maximum number of users.
          
              
      Specified by:
      getMaxUsers in interface DHCPPool
      Returns:
      int Returns a int
    • setMaxUsers

      public void setMaxUsers(int max)
      Information provided by the PKI file:
      
          \brief Set max users
          
          \param max, the maximum number of users.
          
              
      Specified by:
      setMaxUsers in interface DHCPPool
      Parameters:
      max - Takes in a parameter of max
    • getTftpAddress

      public IPAddress getTftpAddress()
      Information provided by the PKI file:
      
          \brief Returns the IP address of the TFTP server.
          
          \return ip, the IP address of the TFTP server.
          
              
      Specified by:
      getTftpAddress in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress
    • getWlcAddress

      public IPAddress getWlcAddress()
      Specified by:
      getWlcAddress in interface DHCPPool
      Returns:
      IPAddress Returns a IPAddress